<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
<!-- qa-pages.qdoc -->
  <title>QA Pages | QDoc Manual 5.14.2</title>
  <link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
  <script type="text/javascript">
    document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
    // loading style sheet breaks anchors that were jumped to before
    // so force jumping to anchor again
    setTimeout(function() {
        var anchor = location.hash;
        // need to jump to different anchor first (e.g. none)
        location.hash = "#";
        setTimeout(function() {
            location.hash = anchor;
        }, 0);
    }, 0);
  </script>
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="main">
    <div class="main-rounded">
      <div class="navigationbar">
        <table><tr>
<td ><a href="../qtdoc/index.html">Qt 5.14</a></td><td ><a href="qdoc-index.html">QDoc Manual</a></td><td >QA Pages</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qdoc-index.html">Qt 5.14.2 Reference Documentation</a></td>
        </tr></table>
      </div>
    </div>
<div class="content">
<div class="line">
<div class="content mainContent">
  <link rel="prev" href="21-3-qt-dita-xml-output.html" />
  <link rel="next" href="qdoc-index.html" />
<p class="naviNextPrevious headerNavi">
<a class="prevPage" href="21-3-qt-dita-xml-output.html">Generating DITA XML Output</a>
<span class="naviSeparator">  &#9702;  </span>
<a class="nextPage" href="qdoc-index.html">QDoc Manual</a>
</p><p/>
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level2"><a href="#generating-the-qa-pages">Generating the QA Pages</a></li>
<li class="level2"><a href="#finding-the-module-s-main-qa-page">Finding the Module's Main QA Page</a></li>
<li class="level2"><a href="#links-to-links-page">Links To Links Page</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QA Pages</h1>
<span class="subtitle"></span>
<!-- $$$28-qdoc-qa-pages.html-description -->
<div class="descr"> <a name="details"></a>
<p>qdoc can generate some extra HTML pages that can be useful for debugging qdoc documentation. These <i>QA</i> pages make it easier for those who write documentation to find links that either go to the wrong targets or don't go anywhere at all.</p>
<a name="generating-the-qa-pages"></a>
<h3 id="generating-the-qa-pages">Generating the QA Pages</h3>
<p>Add <code>-write-qa-pages</code> to the command line to tell qdoc to generate the QA pages. If this option is not provided, the QA pages will not be generated, and previolusly generated QA pages will be deleted.</p>
<a name="finding-the-module-s-main-qa-page"></a>
<h3 id="finding-the-module-s-main-qa-page">Finding the Module's Main QA Page</h3>
<p>The main QA page for a module is not linked into the module's generated documentation, but it is located in the same output directory. To find the top-level QA page for module <i>xxx</i>, set your browser to the qdoc output directory for module <i>xxx</i>. Several files whose names begin with <i>aaa</i> appear at the top of the list. These are the QA pages for module <i>xxx</i>. The file names begin with <i>aaa</i> to ensure that they are easy to find at the top of the directory.</p>
<p>For module <i>xxx</i>, find the file <i>aaa-xxx-qa-page.html</i>. This is the top-level QA page for module <i>xxx</i>. Load that file into the browser. The top-level QA page shows a table that contains links to several QA sub-pages.</p>
<p>For example, the main QA page for <a href="../qtcore/qtcore-module.html">QtCore</a> is <code>aaa-qtcore-qa-page.html</code>. This was the table for <a href="../qtcore/qtcore-module.html">QtCore</a> at one point:</p>
<p class="centerAlign"><img src="images/qa-table.png" alt="" /></p><p>Each table entry shows the number of links from <a href="../qtcore/qtcore-module.html">QtCore</a> to some other module, except for the last entry, which shows the number of broken links in <a href="../qtcore/qtcore-module.html">QtCore</a>. Click the <b>qtquick</b> entry to load the QA subpage showing the links from <a href="../qtcore/qtcore-module.html">QtCore</a> to <a href="../qtquick/qtquick-module.html">QtQuick</a>.</p>
<a name="links-to-links-page"></a>
<h3 id="links-to-links-page">Links To Links Page</h3>
<p>Clicking the <b>qtquick</b> table entry on the main QA page for <a href="../qtcore/qtcore-module.html">QtCore</a> loads the QA subpage showing a table containing all the links from <a href="../qtcore/qtcore-module.html">QtCore</a> to <a href="../qtquick/qtquick-module.html">QtQuick</a>. The table contains all the links constructed with the <a href="08-qdoc-commands-creatinglinks.html#l-command">\l command</a>, as well as the autolinks.</p>
<p class="centerAlign"><img src="images/links-to-links.png" alt="" /></p><p>At the time this table was generated, there were six links from <a href="../qtcore/qtcore-module.html">QtCore</a> to <a href="../qtquick/qtquick-module.html">QtQuick</a>. The first column of each table entry contains a link to some link in <a href="../qtcore/qtcore-module.html">QtCore</a>. The link text as it appears in <a href="../qtcore/qtcore-module.html">QtCore</a> is shown. The second and third columns contain the source file name and line number for where qdoc saw the link in a qdoc comment.</p>
<p><b>Note: </b>The line number will normally refer to the first line of the comment where qdoc saw the link.</p><p>Clicking on a link in the table takes you to that link in the documentation. There the link will be marked with three red asterisks. For example, clicking on the link in the fifth table entry takes you here:</p>
<p class="centerAlign"><img src="images/link-to-qquickitem.png" alt="" /></p><p>The link is marked with three red asterisks. Now you can click on the actual link to check that it goes to the correct place. In this case, the link should go to the reference page for the <a href="../qtquick/qquickitem.html">QQuickItem</a> class. You can check each link in the table this way. If you find a link that goes to the wrong place, use the source file name and line number to find the link, and fix the problem using the square bracket notation for the <a href="08-qdoc-commands-creatinglinks.html#l-command">\l command</a>.</p>
</div>
<!-- @@@28-qdoc-qa-pages.html -->
<p class="naviNextPrevious footerNavi">
<a class="prevPage" href="21-3-qt-dita-xml-output.html">Generating DITA XML Output</a>
<span class="naviSeparator">  &#9702;  </span>
<a class="nextPage" href="qdoc-index.html">QDoc Manual</a>
</p>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</acronym> 2020 The Qt Company Ltd.
   Documentation contributions included herein are the copyrights of
   their respective owners.<br/>    The documentation provided herein is licensed under the terms of the    <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation    License version 1.3</a> as published by the Free Software Foundation.<br/>    Qt and respective logos are trademarks of The Qt Company Ltd.     in Finland and/or other countries worldwide. All other trademarks are property
   of their respective owners. </p>
</div>
</body>
</html>
